Range
Function
This API is used to get Alarm > IP Speaker Parameter range.
Request message
Parameter description
Table 1
Parameter | Range | Type | Description |
---|---|---|---|
speaker | "SP1"…"SPx" Device Supported Speaker device. | string |
Request 1 Example:
POST /API/AlarmConfig/IpSpeakerOnvif/Range HTTP/1.1
{
"version":"1.0",
"data": {
"speaker": "SP1"
}
}
Request 2 Example:
POST /API/AlarmConfig/IpSpeakerOnvif/Range HTTP/1.1
{
"version":"1.0",
"data": {}
}
Response message
Parameter description
Table 2
Parameter | Range | Type | Description |
---|---|---|---|
ip_speaker_info | Json Array | Device information see Table 3 |
Table 3
Parameter | Range | Type | Description |
---|---|---|---|
number | Json int | Serial number | |
enable | Json bool | Whether to enable | |
name | Json string | Device name | |
ip_address | Json string | Device login address | |
port | Json int | Device login port | |
status | "Offline","UnAuther","Online" | string | Status. |
user_name | Json string | User name for logging in to the device | |
password | Json string | Password for logging in to the device | |
password_empty | Json bool | Whether the password of the device login user is empty | |
binding_channel | "SP1"…"SPx" | string array | Bound channel. |
Response 1 Example:
HTTP/1.1 200 OK
Content-Type: application/json
{
"result": "success",
"data": {
"name": {
"type": "string",
"min_len": 0,
"max_len": 31
}
}
}
Response 2 Example:
HTTP/1.1 200 OK
Content-Type: application/json
{
"result": "success",
"data": {
"ip_speaker_info": {
"type": "array",
"min_size": 0,
"max_size": 16,
"items": [
{
"number": {
"type": "int32",
"min": 0,
"max": 15
},
"enable": {
"type": "bool"
},
"name": {
"type": "string",
"min_len": 0,
"max_len": 31
},
"ip_address": {
"type": "string",
"min_len": 0,
"max_len": 63
},
"port": {
"type": "int32",
"min": 1,
"max": 65535
},
"status": {
"type": "string",
"items": [
"Offline",
"UnAuther",
"Online"
]
},
"user_name": {
"type": "string",
"min_len": 0,
"max_len": 35
},
"password": {
"type": "string",
"min_len": 0,
"max_len": 35
},
"password_empty": {
"type": "bool"
},
"binding_channel": {
"type": "array",
"min_size": 0,
"max_size": 16,
"items": {
"type": "string",
"items": [
"CH1",
"CH2",
"CH3",
"CH4",
"CH5",
"CH6",
"CH7",
"CH8",
"CH9",
"CH10",
"CH11",
"CH12",
"CH13",
"CH14",
"CH15",
"CH16"
]
}
}
}
]
}
}
}
Error Code
See Response Messages Body and Common error_code for more information.